omnichannel-ux

(0 reviews)

Update Consent Details

[PATCH]

{businessId}/partyPrivacyProfile/{id}

This usecase is to update consent information of a customer in CRM(Liberate|Cerillion) system.

URL

http://[host]:[port]/omnichannel-ux/{version}/{businessId}/partyPrivacyProfile/{id}

URI Params

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.	Y
id	string	Identifier of the Resource. The leagacy system identify the profile based on billing account.	Y

Headers

name	type	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y

Body Definitions

name	type	description	required
name	string	Name of the privacy profile.	Y
channel	string	Channel object.	Y
channel.@type	string	When sub-classing, this defines the sub-class Extensible name. Default this to "ChannelRef"	Y
channel.id	string	Name of the channel.	Y
partyPrivacyProfileCharacteristic	array	A PartyPrivacyProfileCharacteristic. List of characteristics of the privacy profile.	Y
partyPrivacyProfileCharacteristic.characteristic.name	string	Name of the characteristic	Y
partyPrivacyProfileCharacteristic.characteristic.value	string	Value of the characteristic	Y
partyPrivacyProfileCharacteristic.characteristic.@type	string	When sub-classing, this defines the sub-class Extensible name	Y
partyPrivacyProfileCharacteristic.characteristic.valueType	string	Data type of the value of the characteristic.	N
partyPrivacyProfileCharacteristic.@type	string	When sub-classing, this defines the sub-class Extensible name	N
@type	string	When sub-classing, this defines the sub-class Extensible name	Y

Characteristics

characteristic name	type	description	required
subscribeToSMS	string	This field describes OptIn or OptOut of Marketing SMS	Y
subscribeToEmail	string	This field describes OptIn or OptOut of Marketing Email	Y
subscribeToCalls	string	This field describes OptIn or OptOut of Marketing Calls	Y
subscribeToSurvey	string	This field describes OptIn or OptOut of Marketing Survey	Y
subscribeToAll	string	This field describes OptIn or OptOut of Marketing Services	Y
smsStartDate	string	This field describes the start date when the OptIn or OptOut consent for SMS	N
smsEndDate	string	This field describes the end date when the OptIn or OptOut consent for SMS	N
emailStartDate	string	This field describes the start date when the OptIn or OptOut consent for Email	N
emailEndDate	string	This field describes the end date when the OptIn or OptOut consent for Email	N
callsStartDate	string	This field describes the start date when the OptIn or OptOut consent for Calls	N
callsEndDate	string	This field describes the end date when the OptIn or OptOut consent for Calls	N
surveyStartDate	string	This field describes the start date when the OptIn or OptOut consent for Survey	N
surveyEndDate	string	This field describes the end date when the OptIn or OptOut consent for Survey	N
allConsentStartDate	string	This field describes the start date when the OptIn or OptOut for all consent communication	N
allConsentEndDate	string	This field describes the end date when the OptIn or OptOut for all consent communication	N

Sample Request

{
   "name":"",
   "channel": {
    "@type": "ChannelRef",
    "id": "redmond"
  },
   "partyPrivacyProfileCharacteristic":[
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "subscribeToSMS",
      "valueType": "string",
      "value": "Yes",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "subscribeToEmail",
      "valueType": "string",
      "value": "Yes",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "subscribeToCalls",
      "valueType": "string",
      "value": "Yes",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "subscribeToSurvey",
      "valueType": "string",
      "value": "Yes",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "subscribeToAll",
      "valueType": "string",
      "value": "Yes",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "smsStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "smsEndDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "emailStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "emailEndDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "callsStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "callsEndDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "surveyStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "surveyEndDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
   {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "allConsentStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
   {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "allConsentEndDate",
      "valueType": "string",
      "value": "2025-07-01",
      "@type": "StringCharacteristic"
    }
  }
],
    "@type":"PartyPrivacyProfile"
}

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

Sample Response

{
   "id":"54647849",
   "name":"",
   "channel": {
    "@type": "ChannelRef",
    "id": "redmond"
  },
   "partyPrivacyProfileCharacteristic":[
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "subscribeToSMS",
      "valueType": "string",
      "value": "Yes",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "subscribeToEmail",
      "valueType": "string",
      "value": "Yes",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "subscribeToCalls",
      "valueType": "string",
      "value": "Yes",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "subscribeToSurvey",
      "valueType": "string",
      "value": "Yes",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "subscribeToAll",
      "valueType": "string",
      "value": "Yes",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "smsStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "smsStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "smsEndDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "emailStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "emailEndDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "callsStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "callsEndDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "surveyStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "surveyEndDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "allConsentStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
   {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "allConsentEndDate",
      "valueType": "string",
      "value": "2025-07-01",
      "@type": "StringCharacteristic"
    }
  }
],
    "@type":"PartyPrivacyProfile"
}